﻿#region License, Terms and Conditions
//
// Copyright (c) 2008, aspZone.com
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the <organization> nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY aspZone.com ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL <copyright holder> BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Author(s):
//  John Rudolf Lewis (http://aspZone.com)
//
#endregion

namespace AspZone.Commerce.Model.Domain
{
    /// <summary>
    /// A rule used to calculate the shipping charge for an order.
    /// </summary>
    public class WeightShippingRule
    {
        /// <summary>
        /// Gets or sets the primary unique identifier
        /// </summary>
        public virtual int Id { get; set; }

        /// <summary>
        /// Gets or sets the code of the country that this rule applies to.
        /// </summary>
        public virtual string CountryCode { get; set; }

        /// <summary>
        /// Gets or sets the maximum order weight that this rule applies to.
        /// </summary>
        public virtual decimal MaximumWeight { get; set; }

        /// <summary>
        /// Gets or sets the dollar amount for the rule.
        /// </summary>
        public virtual decimal Amount { get; set; }

        /// <summary>
        /// Determines wheter this <see cref="WeightShippingRule"/> and a specified <see cref="WeightShippingRule"/> are the same entity.
        /// </summary>
        /// <param name="weightShippingRule">the <see cref="WeightShippingRule"/> with which to compare with this <see cref="WeightShippingRule"/>.</param>
        /// <returns>true if the two WeightShippingRules are the same entity.</returns>
        public virtual bool Equals(WeightShippingRule weightShippingRule)
        {
            return weightShippingRule.Id == this.Id;
        }

        /// <summary>
        /// Returns a string representation of this WeightShippingRule,
        /// </summary>
        /// <returns>a string value that represents this WeightShippingRule.</returns>
        public override string ToString()
        {
            return this.Id.ToString(System.Globalization.CultureInfo.InvariantCulture);
        }

        /// <summary>
        /// Returns the hashcode of this instance.
        /// </summary>
        /// <returns>the hashcode of this instance.</returns>
        public override int GetHashCode()
        {
            return this.Id.GetHashCode();
        }
    }
}
